home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 090 / getargs.arc / GETARGS.DOC < prev   
Text File  |  1986-05-03  |  3KB  |  52 lines
  1.  
  2. Program: GETARGS
  3. Author: Steve Titterud
  4. Documentation: GETARGS.DOC (this file)
  5.  
  6. This is a little subroutine which might be used at the front end of
  7. an Xywrite 3 program.  It is, of course, subject to modification in
  8. any degree the user might wish.
  9.  
  10. The basic purpose of this subroutine is to parse the argument passed
  11. with a RUN command, break it into sub-arguments at the boundaries of
  12. delimiters, enabling the user to enter a program with, say, 10 or 15
  13. arguments instead of 1, for further use in the program.
  14.  
  15. The syntax is:  RUN progname arg1[]arg2[]arg3[]arg4[].....argn[]
  16.  
  17.                 where []=delimiter specified by user in GETARGS.
  18.  
  19. In the form uploaded, the delimiter is specified as a comma (,) - this
  20. can be found in the se /,/ command.  Put anyone you like in there; just
  21. make sure you won't use the delimiter within the arguments you intend to
  22. pass!!  The number and size of the arguments you will be able to pass to
  23. the program depends on the resulting length of the command line.  I don't
  24. generally use a large number nor very large strings.  Experiment around
  25. and see what you can get away with.  I can't seem to get more than 70
  26. characters on a command line, including delimiters, no matter what I do.
  27. Of course, if your arguments were small, you can store more than the 15
  28. which getargs stores.
  29.  
  30. The program opens window #9, inserts the argument, then parses it, breaking
  31. it into subarguments.  Each subargument is captured to ALT-z, then assigned
  32. to a numbered variable from 001 to 015, which are then available to your
  33. program.  I show that here by simply aborting the display of the entire
  34. argument and inserting each subargument on its own line with the PV command,
  35. in a new file, showargs.  Note that the last subargument in the list must be
  36. terminated with the delimiter also.  Note also that if you have an ALT-z 
  37. macro loaded, it will be overwritten.
  38.  
  39. This will 'save' null variables in the order of 001-015, too - for example:
  40.  
  41.      RUN getargs MN,IA,,,,WI,,IL,,,CA,,,OR,WA,
  42.  
  43. You may well want to have your program detect a null variable and branch
  44. accordingly - getargs doesn't do this, as it is intended to demonstrate that
  45. the argument passed with the RUN command can be broken down into subarguments,
  46. each of which can be treated as a field for a certain type of value expected
  47. to be initialized by this subroutine for further use in the main program.
  48.  
  49. I hope you find this idea useful at some point in time.
  50.  
  51. End of getargs.doc.
  52.